eFAWATEERcom BANK API icon

eFAWATEERcom BANK API

(0 reviews)

Add Customer Billing

URLs :

Description : This service allows the channel or Bank itself to add a Postpaid billing account for a particular customer with biller information.

Channels or Bank that want to add Postpaid billing account for a customer will pass the Add postpaid customer Billing request to the mule service, mule service will in turn call the eFAWATEERcom endpoint to add the Postpaid billing account request and eFAWATEERcom will add the billing account for that customer.

Mulesoft Request:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id

Request Body: application/json

Field NameTypeLengthOccurrenceDescription
addCustomerBillingObjectM
acctObjectM
joebppsNointeger10Represents the unique identifier of the customer profile in eFAWATEERcom
billingsRecObjectM
billingRecObjectM
billerCodeInteger3MRepresents the unique code of the Biller
billingNostring50MRepresents the unique identifier of subscription in a specific service provided by the biller
serviceTypestring25MRepresents the service type of the biller
nickNamestring50ORepresents the Nike name of the customer billing
End of billingRec
End of billingsRec
End of acct
End of addCustomerBilling
{
"addCustomerBilling": {
"acct": {
"joebppsNo": "3172312341232",
"billingsRec": {
"billingRec": {
"billerCode": "13",
"billingNo": "07999999999",
"serviceType": "Electricity"
}
}
}
}
}

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field NameTypeLengthOccurrenceDescriptionValidation
statusObjectM
successBooleanMtrue false
codeString10MError Code“0” incase of success or Error Code
reasonCodeString50OError Type or Error categoryAdd this tag only incase of error
arabicMessageString200MEnglish message translated to Arabicتمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessageString200MDescription about the processing“The Operation has been Successfully Completed” Or error Description
End of status
responseObjectOExists if success = true
addCustomerBillingObjectM
acctObjectM
joebppsNoInteger10Represents the unique identifier of the customer profile in eFAWATEERcom
resultObject
errorCodestring3M
errorDescstring100M
severityEnum, string7MEnum: Error, Info
End of result
billingsRecObjectM
billingRecobjectM
billerCodeInteger3MRepresents the unique code of the Biller
billingNostring50MRepresents the unique identifier of subscription in a specific service provided by the biller
serviceTypestring25MRepresents the service type of the biller
nickNamestring50ORepresents the Nike name of the customer billing
resultObjectM
errorCodestring3M
errorDescstring100M
severityEnum, string7MEnum: Error, Info
End result
End of billingRec
End of billingsRec
End of acct
End of addCustomerBilling
End of Response
{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response":{
"addCustomerBilling": {
"acct": {
"joebppsNo": "3172312341232",
"result": {
"errorCode": "0",
"errorDesc": "Success",
"severity": "Info"
},
"billingsRec": {
"billingRec": {
"billerCode": "13",
"billingNo": "07999999999",
"serviceType": "Electricity",
"result": {
"errorCode": "0",
"errorDesc": "Success",
"severity": "Info"
}
}
}
}
}
}
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
"success": false,
"code": "400",
"reasonCode": "Bad Request",
"arabicMessage": "اقتراح غير جي",
"englishMessage": "joebppsNo invalid"
}

Reviews